home *** CD-ROM | disk | FTP | other *** search
/ The Macintosh Bible Guide to Games / GameGuideCd.bin / Cheaters / Marathon Stuff / MaraOS Folder / ReadMe < prev   
Text File  |  1995-08-06  |  10KB  |  126 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6. MaraOS v1.0b - a Marathon module manager.
  7. © 1995 Harry Hahn
  8. <mailto:hhahn@calshp.cals.wisc.edu>
  9. <http://apollo.ahabs.wisc.edu/Individuals/Students/Hahn/MarathonStuff.html> (where latest versions are kept).
  10.  
  11. About MaraOS
  12. MaraOS, formerly called Marathon Runner,  is an application that makes it easier to manage all the different Marathon modules (accessory files) you might have accumulated. The usual way to do this involves a lot of copying, moving, renaming, and forgetting. I wrote MaraOS to make this process somewhat simpler- it moves files to their proper place and keeps track of their names so you don't have to.
  13.  
  14. It does this by searching for modules within a certain folder and presenting a dialog with popup menus that allow you to more easily select the different modules you want to use. It tracks the following modules: Marathon Preferences, Map, Music, Physics Model, Shapes, Sounds, and different Marathon applications. It then moves modules to their appropriate locations, renames them, and launches the selected Marathon application.
  15.  
  16. Basically, it's a Startup/Extension Manager kind of program, but  for Marathon.
  17.  
  18. Using MaraOS
  19. To use MaraOS, place it in the same folder as the Marathon application.  Place all modules within this folder. MaraOS will then search this folder and all folders within for modules. You can organize your modules any way you please, but before running MaraOS for the first time, heed the following caveats:
  20.  
  21. - give all your modules names other than the standard Bungie names (no files named "Map"). 
  22. - make sure all modules have unique names (ie 2 files named "Cool Map" = bad).
  23. - make sure you don't have folders with the standard Bungie names
  24. - Don't forget to rename and move the Marathon Preferences file from the Preferences Folder to within Marathon's folder!!!
  25.  
  26. If you've used Marathon Runner in the past, you can probably just simply replace MR (after resetting your modules by running MR one last time) with MaraOS. There is no need to reorganize your modules, except in the case of "<use current>" modules which have to be renamed.
  27.  
  28. Now run MaraOS. After MaraOS searches for modules, you'll be presented with a dialog window with popups from which to choose them. Make your selections and launch Marathon by either clicking on the "Launch Marathon" button or selecting "Launch Marathon" from the File menu (command-L).
  29.  
  30. The selected Marathon will then launch using the selected modules. When Marathon quits, MaraOS will move the module files back to their original locations and you may either quit by selecting "Quit" from the File menu (command-Q) or repeat the selection/launch process.
  31.  
  32. Using Sets
  33. You can link modules by creating sets. MaraOS tracks at least one set, called "Standard". You can create new sets and delete existing ones by selecting "Edit Sets…" from the File menu (command-E). You will then be presented with a dialog window listing all current sets.
  34.  
  35. Clicking on the "New…" button will bring up yet another dialog window asking you to name your new set. Keep set names to 63 characters or less. The new set will configure itself with the current module selections.
  36.  
  37. Selecting a set within the set editing dialog and clicking on the "Delete" button will delete that set. You cannot delete the "Standard" set.
  38.  
  39. Click on the "OK" button or double-click on a set name to exit the set editing dialog.
  40.  
  41. To link modules to a set, select the set in the "Sets" popup menu and then select the modules you wish to link to that set.
  42.  
  43. Preferences
  44. In addition to moving files and launching Marathon, MaraOS can quit Finder for a small speed gain. To do this, open the preferences dialog by selecting "Preferences" from the File menu and click the "Quit Finder" checkbox so that it is on. Please see the technical note below for more information on this feature.
  45.  
  46. You can also have MaraOS move the currently selected set into position when you quit rather than leaving them in their original locations. This can be useful if others play Marathon on your computer and do not use MaraOS. To select this preference, click the "Move on quit" checkbox within the Preferences dialog so that it is on.
  47.  
  48. Technical Notes
  49. MaraOS is a bit slower to start up than Marathon Runner was (making "Runner" something of  a misnomer). This is a consequence of the new file searching algorithm- a trade off of speed for flexibility in organization. However, MaraOS makes up for this lost time by not quitting after launch, so you have the endure the initialization only once. I mostly play NetMarathon and I'm usually the Gathering Dude- I end up switching maps quite frequently. The way I wrote MaraOS reflects this usage, minimizing the downtime between games as I switch modules.
  50.  
  51. If the lag really bothers you, remove extraneous files from the Marathon folder (ReadMes, infrequently used modules, etc.). 
  52.  
  53. The Finder quitting function, though tested, should be used with caution. I only include it because it was rather easy to code and circumvents the need to use another utility (such as an AppleScript) to accomplish this for those who desire the additional speed gain. There may arise situations where the Finder is expected and crashes may result. To decrease the likelihood of such a crash, make sure all other applications are quit before running MaraOS.
  54.  
  55. None of the items in the Edit menu do anything.
  56.  
  57. While other similar applications (Marathon Mystifier and Marathon Master for example) accomplish the same goal as MaraOS by modifiying Marathon to look for a particular module, I've opted to move files to accomodate Marathon. I do this out of my own reservations at modifying the Marathon application in any way. A downside to this is that file tracking is a bit more complicated and can sometimes get confused. If this happens, move and rename files manually as appropriate, and if that doesn't work, throw out the MaraOS Preferences file.
  58.  
  59. As the "b" in the version indicates, MaraOS is in beta release (the features list is locked). This means that there are probably bugs. If bugs make you mad and prone to writing authors nasty and unconstructive e-mail, please don't use MaraOS. If on the other hand you  don't mind beta testing  and encounter a bug, please don't hesitate to let me know. Being able to reproduce the bug is even better. Forgetting to move your Marathon Preferences file out of your Preferences folder and into Marathon's folder is not a bug.
  60.  
  61. Legal Stuff
  62. MaraOS is freeware, my way of giving back to the Marathon community for all the cool things that have come out of it. All I ask is that you consider dropping me an e-mail to tell me what you think, even if it is only to tell me how utterly boring and dry the ReadMe is.
  63.  
  64. While MaraOS is freeware, it is not public domain and I retain all rights. It may be freely distributed but please do not distribute modified copies and include the ReadMe. Also, please do not include MaraOS in a software bundle  without prior permission.
  65.  
  66. Thanks to
  67. Scott Johnson  - for the original idea and creative input
  68. Michael Leetmaa - for technical assistance
  69. Guillaume Fortin (author of Marathon Mystifier) - for technical discussion
  70. Nathan Federici - for the Copland-style folder icon
  71. Jim Luther of Apple Computer- for MoreFiles, saving me (and consequently the world) from writing my  own copying routines
  72. All the kind folks at c.s.m.programmer.help - for never letting my stupid questions go unanswered
  73. All the kids in the AHABS and Chemistry zones here at the University of Wisconsin - for providing me with my daily Marathon fix (yes, addiction is an ugly thing)
  74.  
  75. Version History
  76. 1.0b
  77.     - Quits Finder on request
  78.     - "Move on quit" feature moved to preferences
  79.     - Fattening cosmetics added
  80. 1.0a3
  81.     -    Released 26 June
  82.     - Fixed error whereby MaraOS failed to move modules when on non-startup volume (thanks to Robert Fleming for patiently working through this with me)
  83.     - Saves window position
  84.     - Implemented app quitting (barely)
  85. 1.0a2
  86.     - Released 20 June 1995
  87.     - Added Move & Quit item to File menu
  88.     - Tweaked error alerts so that they are slightly (just slightly) more informative
  89.     - Gives error if duplicate module names are found
  90.     - Gives error if files with Bungie standard names are found
  91.     - Made Launch button "default" (<return> or <enter>)
  92. 1.0a1
  93.   - Released 8 June 1995
  94.     - Just about re-wrote the whole damn thing
  95.     - Changed name of application from Marathon Runner to MaraOS
  96.     - Changed appearance of popups- they were proliferating like rabbits
  97.     - Re-wrote module searching and tracking routines
  98.     - Control of application to launch (ie different versions of Marathon)
  99.     - Made dialog modeless. It was very hard. It took a long time.  It still doesn't work well.
  100.     - Implemented sets. It was very hard. It took a long time. I hope you like it.
  101.     - Splash screen eye candy as you wait for start up 
  102.     - Fixed bug where Prefs file wouldn't transfer if Marathon wasn't on startup volume (what a pain!)
  103. 1.0d5
  104.     - Released 18 April 1995
  105.     - Fixed bug where if module of wrong file type was found, menu building stopped prematurely
  106.     - Fixed chaos that resulted when a module had Bungie's blessed name within the module folder
  107.     - Added some checks for file renaming and moving calls
  108. 1.0d4
  109.     - Released 13 April 1995 (wee! 3rd one in less than 24 hours! What a fucking fiasco.)
  110.     - Hopefully fixed character restriction for file names in a manner suitable for PowerMacs
  111. 1.0d3
  112.     - Released 13 April 1995
  113.     - Fixed problem causing failure on PowerMacs
  114.     - Re-introduced module name character restriction bug as a result
  115. 1.0d2
  116.     - Released 13 April 1995
  117.     - Fixed STR# for Physics Model to "Physics Model" (not "Physics". Duh.)
  118.     - Revamped ALRTs (they're a little less cryptic)
  119.     - Changed format of preferences file- this will probably change every revision :-(
  120.     - Now filters folders for correct file types
  121.     - Put in "<none>" selection for Physics and Music
  122.     - Popups display last used modules upon open (i.e. defaults)
  123.     - Fixed menu building so files that have a "/" in them don't screw up the popups
  124.     - Ignores control of module types when no folder is present
  125. 1.0d1
  126.     - Released 6 April 1995